Microsoft Cognitive Language Service - Analyze Text Authoring (preview:2024-11-15)

2025/04/15 • 1 updated methods

TextAuthoringProject_Train (updated)
Description :  Triggers a training job for a project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAuthoringProject_Train",
  "$parameters": {
    "body": {
      "$properties": {
        "dataGenerationSettings": [
          {
            "dataGenerationConnectionInfo": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "AzureOpenAI",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "azureOpenAI",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:train
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The training input parameters. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents the output model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
evaluationOptions:
{
Description: Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20. ,
Required: False ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataGenerationSettings:
{
Description: Represents the settings for using data generation as part of training a custom model. ,
Required: False ,
}
{
enableDataGeneration:
{
Description: If set to true, augment customer provided training data with synthetic data to improve model quality. ,
Required: True ,
}
boolean ,
dataGenerationConnectionInfo:
{
Description: Represents the connection info for the Azure resource to use during data generation as part of training a custom model. ,
Required: True ,
}
{
kind:
{
Description: Connection type for data generation settings. Currently only supports Azure Open AI. ,
Enum:
{
AzureOpenAI: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: Resource ID for the data generation resource. Looks something like "/subscriptions//resourceGroups//providers/Microsoft.CognitiveServices/accounts/". ,
Required: True ,
}
string ,
deploymentName:
{
Description: Deployment name of model to be used for synthetic data generation. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}